Data Groups
With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.
CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.
For information about data group definitions and device template files, see Device Template Files.
For more information about data group dependencies, see Data Group Dependencies.
Utilize user-defined templates to match Totalflow device register configurations. To add additional register-based data groups, you must first add the Application Config data group. You can use this feature to poll a device for a list of the manufacturer-provided applications available on the device. Device configuration and application availability depend on your particular agreement with Totalflow.
The Totalflow EIE device template files include a file that retrieves data from an ABB trend. This trend must be configured on the Totalflow remote device before it can be polled by the Totalflow EIE. Although CygNet provides alternate ways to trend field device data, trending at the remote device level in the Device Definition Service (DDS) is more reliable and precise since it does not depend on a communication device to constantly relay data.
Units must be supplied using the units attribute within native data groups wherever appropriate. Make sure that the units defined in your template match those defined on your field device.
Notes:
- Register-based and trend-based data groups are not supported by the DB1 protocol. Register-based and trend-based data groups are supported by the DB2 protocol, but their uses are device specific. All register-based data groups require device configuration.
- Totalflow hourly records are timestamped at the beginning of an hour and are only recorded after an hour completes. Trend records are timestamped at the end of the reporting period.
-
When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
-
Best practice recommends that you do not perform UDC and point processing on FMS data groups. The DEIDs specified in FMS data groups are generic and use the eFMS enumeration to identify the CygNet-defined FMS items referenced in the device template file. No polling is done on these data groups — all data is coming from the native data groups. Points should be mapped to the native data groups since that is the data group that is actually processing the device data. While point processing may work on the FMS data groups, it is not supported, not tested, not consistent across EIEs, and is not recommended practice.
Totalflow EIE Data Groups
Browse by letter: [A] [B] [C] [D] [F] [H] [I] [P] [R] [S] [T] [V]
| Data Group Type | Usage Notes |
|---|---|
|
"Analogs and Digitals - Register" Register-based. DB1 protocol devices do not support registers. |
|
|
AppBasic |
"App Basic Poll" Register-based. DB1 protocol devices do not support registers. |
|
"Application Config" All of the device applications you purchased rights to for a given Totalflow device appear here. You must get data for the "Application Config" data group before polling any other register-based data groups. See also Register Data Group and Application ID. |
|
|
"Basic Poll" is retrieved independently or as part of an archive with "Meter Configuration","History - Events","History - Daily", and "History - Log Period". |
|
|
"Command Message" Note: For devices running 6400, 6700, and API firmware, only host time can be sent from the device using the "Command Message" (CmdMsg) data group. The Time Zone page on the Device Editor must be set to the default "Always Use Computer Time Zone". If another time zone is selected, a command message will not be sent with the above firmware. |
|
|
ComConfig |
"Comm Config" Register-based. DB1 protocol devices do not support registers. |
|
Composite Data Group |
The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group. |
|
"Meter Configuration" is retrieved independently or as part of an archive with "Basic Poll", "History - Events", "History - Daily", and "History - Log Period". Supports liquid configuration items. |
|
|
CryInfo |
"Cryout Info" |
|
Cryout |
"Cryout" information received from a device when it cries out. |
|
Current |
"Current Data - Register" Resister-based. DB1 protocol devices do not support registers. |
|
"Date/Time" Register-based. DB1 protocol devices do not support registers. |
|
|
"FCU Header" |
|
|
"FMS Alarms" FMS data group units displayed in the DDS reflect their points of origin. Set and cleared flags for "FMS Alarms" are calculated using 2 consecutive "History - Log Period" records. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
|
|
|
FmsConfig |
"Application Configuration" and "Meter Configuration" must be retrieved before you use "FMS Configuration." FMS data group units displayed in the DDS reflect their points of origin. "FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal. Dependencies:
|
|
"FMS Events" FMS data group units displayed in the DDS reflect their points of origin. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
|
|
|
"FMS Daily PM History" FMS data group units displayed in the DDS reflect their points of origin. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
|
|
|
"FMS Hourly PM History" FMS data group units displayed in the DDS reflect their points of origin. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
|
|
|
"FMS Hourly PQ History" FMS data group units displayed in the DDS reflect their points of origin. Specify date ranges on a per-data group basis within the device editor. For more information, see Selecting Date and Time. Dependencies:
Note: The "History - Gas Data" data group requires a file name in the Data Group Properties dialog box File Name field. To determine the name of the file, check the "Trend List" data group. |
|
|
"History - Daily" is retrieved as part of an archive with "Basic Poll", "Meter Configuration", "History - Events", and "History - Log Period". DB1 - use only to request the last 3, 10, or 35 days of history; some history items are not available. DB2 - use to request history data by contract day. |
|
|
"History - Event" is retrieved as part of an archive with "Basic Poll", "Meter Configuration", "History - Daily", and "History - Log Period". DB1 - use only to request the last 3, 10, or 35 days of history; some history items are not available. DB2 - use to request history data by contract day. |
|
|
"History - Gas Data" a pre-configured trend. |
|
|
"History - Log Period" is retrieved as part of an archive with "Basic Poll", "Meter Configuration", "History - Events", and "History - Daily". DB1 - use only to request the last 3, 10, or 35 days of history; some history items are not available. DB2 - use to request history data by contract day. |
|
|
"I/O Subsystem" Register-based. DB1 protocol devices do not support registers. |
|
|
"Plunger Afterflow" |
|
|
PlnArr |
"Plunger Arrival" Register-based. DB1 protocol devices do not support registers. |
|
PlnArv |
"Plunger Arriving" Register-based. DB1 protocol devices do not support registers. |
|
PlnAvd |
"Plunger Arrived" Register-based. DB1 protocol devices do not support registers. |
|
PlnClsVlv |
"Plunger Closing Valve" Register-based. DB1 protocol devices do not support registers. |
|
"Plunger Commands" Register-based. DB1 protocol devices do not support registers. |
|
|
"Plunger Configuration Basic" Register-based. DB1 protocol devices do not support registers. |
|
|
PlnConfig |
"Plunger Configuration" Register-based. DB1 protocol devices do not support registers. |
|
"Plunger Control" Register-based. DB1 protocol devices do not support registers. |
|
|
PlnCycCls |
"Plunger Cycles - Close" Register-based. DB1 protocol devices do not support registers. |
|
PlnCycOpn |
"Plunger Cycles - Close" Register-based. DB1 protocol devices do not support registers. |
|
PlnHBlVl |
"Plunger History - Blow Valve" Register-based. DB1 protocol devices do not support registers. |
|
PlnHFail |
"Plunger History - Failure" Register-based. DB1 protocol devices do not support registers. |
|
PlnHist |
"Plunger History" Register-based. DB1 protocol devices do not support registers. |
|
PlnReg |
"Plunger Registers" Register-based. DB1 protocol devices do not support registers. |
|
PlnStat |
"Plunger Statistics" Register-based. DB1 protocol devices do not support registers. |
|
PlnStat |
"Plunger Status" Register-based. DB1 protocol devices do not support registers. |
|
PlnStatBas |
"Plunger Status Basic" Register-based. DB1 protocol devices do not support registers. |
|
PlnState |
"Plunger State" Register-based. DB1 protocol devices do not support registers. |
|
PlnVlvCls |
"Plunger Valve Closed" Register-based. DB1 protocol devices do not support registers. |
|
PulseAcc |
"Pulse Accumulator" Register-based. DB1 protocol devices do not support registers. |
|
"Register - Device Specific" Register-based. DB1 protocol devices do not support registers. In edit mode, a Send only edited items check box displays on the View Data dialog box, and when selected, only the edited values are written to the DDS transaction. |
|
|
"System Applications" Register-based. DB1 protocol devices do not support registers. |
|
|
SysReg |
"System Registry" Register-based. DB1 protocol devices do not support registers. |
|
SysSetup |
"System Setup" Register-based. DB1 protocol devices do not support registers. |
|
"Tank Data" Register-based. DB1 protocol devices do not support registers. |
|
|
TankData |
"Tank Data - Register" Register-based. DB1 protocol devices do not support registers. |
|
TankStatus |
"Tank Status - Register" Register-based. DB1 protocol devices do not support registers. |
|
"Trend Config" See Trend Requests. DB1 protocol devices do not support trending. |
|
|
"Trend - Device Specific" See Trend Requests. DB1 protocol devices do not support trending. |
|
|
"Trend List" See Trend Requests. DB1 protocol devices do not support trending. |
|
|
TubeSULiq |
"Liquid Tube" |
|
TubeSULSUp |
"Liquid Tube SetUp" |
|
"Valve Control" This data group is intrinsic to 6700 (G2) devices when using DB1 protocol. Register-based for G3 and later devices. |
